﻿#region Copyright(c) 2006 ZO, All right reserved.
// -----------------------------------------------------------------------------
// Copyright(c) 2006 ZO, All right reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
//   1.  Redistribution of source code must retain the above copyright notice,
//       this list of conditions and the following disclaimer.
//   2.  Redistribution in binary form must reproduce the above copyright
//       notice, this list of conditions and the following disclaimer in the
//       documentation and/or other materials provided with the distribution.
//   3.  The name of the author may not be used to endorse or promote products
//       derived from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
// WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
// MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
// EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
// OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
// ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
// -----------------------------------------------------------------------------
#endregion


#region Using directives

using ZO.SmartCore.IO;

#endregion

namespace ZO.SmartCore.Configuration
{
    /// <summary>
    /// The base interface for all of formmater used to read or write configuration in custom format
    /// </summary>
    public interface IConfigurationFormat
    {


        #region Events

        #endregion

        #region Properties
        /// <summary>
        /// Gets the default section.
        /// </summary>
        /// <value>The default section.</value>
        Section DefaultSection { get; } // DefaultSection

        /// <summary>
        /// Get The Name of Format used by the Formatter
        /// </summary>
        /// <value>format name.</value>
        string Name { get; }

        #endregion

        #region Methods
        /// <summary>
        /// Write the specified section to memory stream and return it;
        /// </summary>
        /// <returns>memory stream containing the section</returns>
        StringStream Write();

        /// <summary>
        /// Reads the specified contents.
        /// </summary>
        /// <param name="contents">The contents.</param>
        void Read(StringStream contents);
        #endregion
    }
}
